Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Miscellaneous cleanup of warnings; formatting #123

Merged
merged 1 commit into from
Apr 29, 2022

Conversation

tsj5
Copy link
Collaborator

@tsj5 tsj5 commented Dec 5, 2021

This is a "catchall" PR for improvements to code and docstring formatting and resolving non-critical linter warnings and other julia recommended practices. See individual commits for the changes made.

Changes here do not modify the code's functionality or performance in any way.

@tsjackson-noaa
Copy link
Collaborator

PR updated with refinements to docstrings. Verified that docs build locally.

Copy link
Collaborator

@odunbar odunbar left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM - I think i would rather we implement climaformat sooner rather than later! Please rerun climaformat after merge of 124, and 132, then happy to merge this

Auto-generate signatures in documentation

Use DocStringExtensions to auto-generate signatures and typedefs, since
manually maintained docs are at risk of going out of sync with the code.

Auto-generate signatures in documentation

Use DocStringExtensions to auto-generate signatures and typedefs, since
manually maintained docs are at risk of going out of sync with the code.

Update Manifest for build on Julia 1.6

Tweak docstring grammar/formatting

Ensure docs for constructors are generated

Run climaformat.jl
@tsj5 tsj5 force-pushed the tsj/cleanup-warnings branch from dcc1ea8 to c7e83dc Compare April 29, 2022 06:18
@tsj5
Copy link
Collaborator Author

tsj5 commented Apr 29, 2022

bors r+

@bors
Copy link
Contributor

bors bot commented Apr 29, 2022

@bors bors bot merged commit c9839e4 into CliMA:master Apr 29, 2022
@tsj5 tsj5 changed the title [WIP] Miscellaneous cleanup of warnings; formatting Miscellaneous cleanup of warnings; formatting Apr 29, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants